home *** CD-ROM | disk | FTP | other *** search
/ Amiga Games: Greatest Hits 1996 / Amiga Games: Greatest Hits 1996.iso / userbox / publicdomain / atb213 / atb.doc < prev    next >
Text File  |  1996-05-28  |  15KB  |  377 lines
  1.  
  2. ATB quick documentation (note in english)
  3. -----------------------------------------
  4.  
  5.  
  6. I was urged to release this version of ATB by many users.
  7. This release of ATB is a dead-end version, it is in fact
  8. software dust. please do not send ANY emails with questions
  9. about ATB. It was too much work to translate my interim
  10. man page into portable english, so this quick documentation
  11. is written in german and an old one (many, many features
  12. are not described)
  13.  
  14. At the end of this document I've pasted some parts of the
  15. source that you should read to understand most of the features
  16. that are new.
  17.  
  18. ! if you're not familar with "german", use someone else to
  19. ! help you. 
  20. ! tip: visit #amigager (german amiga users IRC channel) and
  21. ! ask someone for (translation-) help.
  22.  
  23. ---------------------------------------------------------------------
  24.  
  25. Amiga ToolBar 2.0 Features und Neuigkeiten
  26. ------------------------------------------
  27.  
  28. 1.) Einleitung
  29. ==============
  30.  
  31. Amiga ToolBar wurde programmiert um einen flexiblen und kleinen
  32. "ToolManager" für meine persöhnlichen Bedürfnisse zu besitzen.
  33. Es sollte konfigurierbare Knöpfe besitzen und ein paar wichtige
  34. Statusinformationen anzeigen sowie eine kleine Kommandozeile
  35. für direkte Shell Eingaben besitzen. Um Farbe und Form nach
  36. belieben zu ändern wurde es mit MUI 3.x programmiert, was auch
  37. einige andere Vorteile mit sich bringt.
  38.  
  39. 2.) Fähigkeiten
  40. ===============
  41.  
  42. Buttons:
  43.  
  44. + Konfigurierbare Buttons zum Starten von Programmen
  45. + Piktogramme können als Argumente via Drag'n'Drop übergeben werden
  46. + persöhnliche Help-Bubble für die einzelnen Buttons
  47. + Button Beschriftung ist ein MUI Text, d.h. inline Grafiken möglich
  48. + Buttons auch per Tastatur aktivierbar (Tab,Return)
  49. + Buttons können in mehrere Zeilen aufgeteilt werden
  50. + Jeder Button hat seine eigene Konfiguration
  51.  
  52. Goodies:
  53.  
  54. + Speicheranzeige für Chip/Fast
  55. + Screentitle Anzeige für Leute die den Screentitle abgeschaltet haben
  56. + Direkt-Kommandozeile für schnelle Aktionen (z.B. mount RAD: usw.)
  57. + Drag'n'Drop in die Kommandozeile
  58. + Position der Anzeigen durch Drag'n'Drop austauschbar
  59. + Breite der einzelnen Anzeigenelemente 'ziehbar'
  60. + Einzeln aktivierbar/abschaltbar
  61.  
  62. Fenster:
  63.  
  64. + Fensterposition beliebig wählbar (Linke obere Ecke)
  65. + Feste Breite kann erzwungen werden
  66. + Vertikale oder Horizontale Anordnung der Knöpfe
  67. + Iconify des Fensters per Menu,Hotkey oder "Commodities Exchange"
  68. + MUI Fenster; d.h. Farben usw. einstellbar mit dem MUI Prefs Editor
  69.  
  70. Sonstiges:
  71.  
  72. + Konfigurationsdatei wird notifiziert; änderungen an der Datei werden sofort übernommen -> gut zum Testen!
  73. + Konfigurationsdatei ist mit jedem bel. Texteditor erstellbar
  74. + "Cyclechain" für alle Bedienelemente
  75.  
  76. 3.) Installation
  77. ================
  78.  
  79. Das Paket besteht aus dem eigentlichem Programm "ATB" (AmigaToolBar)
  80. und einer Konfigurationsdatei. ATB kann nur aus der Kommandozeile
  81. heraus gestartet werden und kennt nur diese beiden Argumente:
  82.  
  83. CFG=CONFIG/K,Q=QUIET/S:
  84.  
  85. CONFIG ist der Name der Konfigurationsdatei, d.h. man kann einen beliebigen
  86.        Platz auf seiner Festplatte für diese Datei wählen.
  87.        Wird kein Dateiname angegeben, so wird S:AmiToolBar.prefs verwendet.
  88. QUIET  unterdrückt die initiale Copyright Meldung.
  89.  
  90. Das Programm ATB sollte man sich in seinen Suchpfad kopieren, z.B. nach C:.
  91. Der beste Platz zum Starten von ATB ist in der S:User-StartUp Datei;
  92. folgende Zeilen sind zu ergänzen:
  93.  
  94. ;BEGIN Amiga ToolBar
  95. run <>NIL: ATB CONFIG=ENV:AmigaToolBar.prefs QUIET
  96. ;END Amiga ToolBar
  97.  
  98. Nun muss noch eine Konfigurationsdatei erstellt werden.
  99.  
  100. 4.) Konfigurationsdatei
  101. =======================
  102.  
  103. Die Konfigdatei hat ein bestimmtes Format und kann mit jedem bel. Texteditor
  104. erstellt werden. Sie wird ZEILENWEISE abgearbeitet und benutzt die Notation
  105. für AmigaDOS Kommandoschablonen (siehe AmigaDOS Handbuch).
  106.  
  107. Die ERSTE Zeile in der Datei wird mit folgender Schablone dekodiert:
  108. "T=TOP/N/K,L=LEFT/N/K,W=WIDTH/N/K,R=ROWS/N/K,MD=MEMORYDISPLAY/S,TD=TITLEDISPLAY/S,CP=COMMANDPANEL/S,MDW=MDWeight/N,TDW=TDWeight/N,CPW=CPWeight/N"
  109. JEDE WEITERE Zeile beschreibt einen Kommandoknopf und benutzt diese Schablone:
  110. "TITLE/A,COMMAND/A,PATH/A,STACK/N/A,PRI/N/A,QUIET/S,WBSTART/S,HELP"
  111.  
  112. Alle Zeichen nach einem Semikolon (;) werden bis zum Zeilenende ignoriert, sind
  113. also ein Kommentar. Beispiel:
  114. ; Dies ist ein Kommentar
  115.  
  116. WICHTIG! Die erste Zeile der Datei enthält globale Optionen und darf daher kein
  117. Kommentar sein (darf aber einen Kommentar enthalten).
  118.  
  119. Globale Optionen:
  120. ----------------
  121.  
  122. T=TOP/N/K: Position der Fensteroberkante. Standard ist die grösstmögliche untere
  123.            Position auf dem Bildschirm
  124.  
  125. L=LEFT/N/K: Wie TOP, nur für die Linke Kante des Fensters. Standard ist soweit
  126.             rechts wie möglich
  127.  
  128. W=WIDTH/N/K: Hiermit kann man eine bestimmte Breite für das Fenster beantragen.
  129.              Wenn der Fensterinhalt aber nicht in diese Breite hineinpasst,
  130.              so wird MUI das Fenster selbstständig vergrößern!
  131.  
  132. R=ROWS/N/K: Gibt an, in wieviele Zeilen die angegebenen Buttons aufgeteilt werden
  133.             sollen, z.B. ROWS=2 für eine zweispaltige Buttonleite
  134.  
  135. MD=MEMORYDISPLAY/S,
  136. TD=TITLEDISPLAY/S,
  137. CP=COMMANDPANEL/S: Standardmässig wird kein Goodie aktiviert, sie werden mit
  138.                    diesen Schaltern aktiviert. "MD TD CP" aktiviert z.B. alle
  139.                    Goodies.
  140.  
  141. MDW=MDWeight/N,
  142. TDW=TDWeight/N,
  143. CPW=CPWeight/N: Die drei Goodies teilen sich die untere Zeile; mit diesen
  144.                 drei Gewichten wird der beanspruchte Platz verteilt.
  145.  
  146.  
  147. Button Optionen:
  148. ---------------
  149.  
  150. TITLE/A: Beschriftung des Buttons. Dies ist ein MUI Text, daher kann man
  151.          hier alle Steuersequenzen benutzen, die im MUI Developer Paket
  152.          beschrieben sind, z.B. Fett, Kursiv oder Inline Grafiken.
  153.          Beispiel: "\33I[5:sys:images/amiga.br]\33bShell"
  154.          (\33 soll der ASCII Code für Escape sein, also dezimal 27. Dies
  155.          kann man bei manchen Editoren direkt eingeben). Es wird geraten,
  156.          sich das MUI3xDEV.lha aus dem Aminet zu besorgen.
  157.  
  158. COMMAND/A: Das Kommando, das gestartet werden soll. Wichtig: am Ende der
  159.            Kommandozeile werden etwaige Argumente angehangen (z.B. durch
  160.            Drag'n'Drop). Werden zusätzlich Argumente verwendet, so sollte
  161.            man das Kommando und die Argumente in Anführungszeichen setzen,
  162.            Beispiel: "NewShell CON:///"
  163.  
  164. PATH/A: Das Verzeichnis aus dem heraus das Kommando gestartet wird. Viele
  165.         Programme verlangen aus ihrem Stammverzeichnis heraus gestartet
  166.         zu werden.
  167.  
  168. STACK/N/A: Die Stackgröße für das Programm
  169.  
  170. PRI/N/A: Die Prozeßpriorität für den zu erzeugenen Prozeß
  171.  
  172. QUIET/S: Stellt als Eingabe und Ausgabe NIL: ein. Dies ist wichtig,
  173.          da einige Programme wie z.B. Multiview sonst nervige
  174.          Ausgaben in die Bootshell machen
  175.  
  176. WBSTART/S: use wbstart.library to simulate WBSTART's
  177.  
  178. HELP: die Rest der Zeile kann für einen kleinen Hilfetext verwendet werden,
  179.       der in einer MUI Helpbubble erscheint, wenn man mit der Maus auf diesen
  180.       Knopf zeigt.
  181.  
  182. Hier ist ein Beispiel einer Konfigurationsdatei:
  183.  
  184. -----------------------------------------------
  185. ROWS=2 MEMORYDISPLAY TITLEDISPLAY COMMANDPANEL
  186. ; the first line contains the global options
  187. ; here are the button descriptions, 2x3 buttons (ROWS=2!!)
  188. "I[5:sys:images/amiga.br] Shell"       "newshell CON:50/449/700/98" RAM:   4096 0 QUIET "Open a new bShelln window"
  189. "I[5:sys:images/amiga.br] Delitracker" "DeliTracker2"               AUDIO: 4096 0 QUIET "bDelitrackern 2.21 - Module Player"
  190. "I[5:sys:images/amiga.br] Textview"    "SYS:Utilities/TextView"     RAM:   4096 0 QUIET "bMostn 1.57 - Text Viewer"
  191. "I[5:sys:images/amiga.br] Multiview"   "SYS:Utilities/Multiview"    RAM:   4096 0 QUIET "bMultiviewn from Commodore"
  192. "I[5:sys:images/amiga.br] View"        "Work:Viewers/CyberView"     RAM:   4096 0 QUIET "bCyberViewn - Picture Viewer"
  193. "I[5:sys:images/amiga.br] Scout"       "Work:Infotools/Scout"       RAM:   8192 0 QUIET "bScoutn - System Monitor"
  194. -----------------------------------------------
  195.  
  196. 5.) Fragen und Antworten
  197. ========================
  198.  
  199. ? ist eine Frage,
  200. ! ist die entsprechende Antwort
  201.  
  202. --
  203.  
  204. ?: Wie bekomme ich eine Vertikale Leiste ?
  205. !: Den ROWS= Parameter auf die Anzahl der Knöpfe setzen die man hat
  206.    und mit dem WIDTH= Parameter die Breite der Leiste einstellen.
  207.    Stellt man WIDTH=1 ein, so wird MUI die Optimale Breite finden.
  208.    Man sollte zusätzlich noch keines der Goodies anschalten, da diese
  209.    doch recht stören (zumindest alle 3 passen meistens nicht).
  210.    Will man mehr Spalten haben, z.B. zwei 10er Spalten, so definiert
  211.    man sich 20 Buttons und setzt ROWS=10.
  212.  
  213. ?: Wie starte ich AREXX Skripte mit ATB ?
  214. !: Eine Möglichkeit ist diese mit RX zu starten
  215.  
  216. ?: Und wie starte ich Workbench Programme mit TOOLTYPES ?
  217. !: Im Aminet sollte es Programme geben, die einen Workbench-
  218.    Start vom CLI aus simulieren. Damit sollte es vorrübergehend
  219.    klappen, ich habe es aber noch nicht getestet. In einer
  220.    nächsten Version wird es auch einen Workbench Start geben.
  221.  
  222. ?: Wenn ich die Anzeigen in der unteren Zeile neu anordne, so wird
  223.    dies nicht gespeichert.
  224. !: Leider müssen diese Werte zur Zeit von Hand in das Konfigurations-
  225.    file eingetragen werden
  226.  
  227. ?: konfigurieren von Hand ist mühsam; gibt es denn keinen Prefseditor ?
  228. !: Doch, aber der ist nicht von mir. Die Veröffentlichung liegt beim
  229.    anderem Autor, vielleicht wird der Editor im nächsten Paket enthalten
  230.    sein.
  231.  
  232. ?: Wie bekomme ich den Text zentriert und wie bekomme ich diese kleinen
  233.    Bildchen in den Buttontext ?
  234. !: Indem du dir die MUI Developer Dateien besorgst und in der Sektion
  235.    TEXT und IMAGES in den mitgelieferten Autodocs nachliest, wie das
  236.    geht.
  237.  
  238. ?: Ich habe die erste ATB Version schon benutzt, und jetzt sind die
  239.    Texte in den Buttons nicht mehr zentriert. Wieso ?
  240. !: Weil ich die voreingestellte Zentrierung ausgeschaltet habe. Man
  241.    muss nur ein <ESCAPE>c voransetzen um sie wieder zu aktivieren
  242.  
  243. ?: Ich will ein 16x16 Bild benutzen mit einem 13 Punkte hohem Font...
  244. !: ..aber vom Bild werden nur 13 Punkte höhe angezeigt ? Die Bilder
  245.    dürfen nur so hoch sein wie der Punkt. Es gibt eine unelegante
  246.    Lösung für das Problem: man erstellt einen 16 Punkte hohen Font,
  247.    der z.B. nur 10 Punkte hoch ist und oben und unten 3 Pixel frei
  248.    läßt - zugegeben, ziemlich miese Methode.
  249.  
  250. ?: Mein Inline Image ist nach rechts hin immer kaputt.. ?
  251. !: Dann hast du das Bild nicht korrekt abgespeichert/erstellt. Manche
  252.    Programme sichern Brushes falsch. Diese Frage sollte aber eher an
  253.    die MUI Autoren geschickt werden.
  254.  
  255. ?: Wenn ich manchmal auf einen Button klicke, so passiert nichts ausser
  256.    das die Kommandozeile aktiviert wurde...?
  257. !: Evt. ein MUI Bug: du hattest zuletzt das Stringgadget aktiviert und
  258.    dann ein anderes Fenster aktiviert. Klickst du nun in ATB, so wird
  259.    das Stringgadget wieder aktiviert, dein Klick aber "verschluckt".
  260.    Ich habe noch keine Lösung für dieses Problem...
  261.  
  262. ?: Manchmal kann ich keine Piktogramme mehr auf ATB werfen, es erscheint
  263.    dann eine Fehlermeldung..?
  264. !: Ups! Das sollte nicht mehr passieren. Einfach im Menu "MUI Settings"
  265.    aufrufen und die Einstellungen "Sichern". Ich habe dieses Phänomen
  266.    auch schon ab und zu gehabt und weiss wirklich nicht wieso.
  267.  
  268. 6.) Tips zur Einstellung
  269. ========================
  270.  
  271. Diese Sektion beschreibt Einstellungen mit dem MUI Prefs Editor,
  272. die ich für besonders sinnvoll halte im Zusammenhang mit ATB:
  273.  
  274. Dies soll nur als Anregung gedacht sein, jeder sollte mit MUI
  275. seine Oberflächen nach seinem Geschmack einstellen.
  276.  
  277. Ich beziehe mich hier auf MUI 3.3 Prefs
  278.  
  279. "System"
  280.      Iconify:
  281.       - Hotkey: frei nach wahl, RechteAmiga-i im Programm eingebaut
  282.       - Zeige:  Icon
  283.     Arexx:  aus
  284.  
  285. "Fenster"
  286.     Kontrolle:
  287.      - Positionen: am Ende merken
  288.      - Refresh:    smart
  289.      - Neuzeichnen:mit Löschen
  290.      - Knöpfe:     keine
  291.     Abstand:       1-1-1-1
  292.  
  293. "Gruppen"
  294.     Rahmen:
  295.      - Normal:      keiner, Links=Rechts=4, Oben=Unten=1
  296.     Abstand:       1-1
  297.  
  298. "Strings"
  299.     String Farbe (inaktiv):
  300.      - Hintergrund/Text: schwacher Kontrast (hellgrau/dunkelgrau)
  301.     String Farbe (aktiv):
  302.      - Hintergrund/Text: starker Kontrast (weiss/schwarz)
  303.  
  304. Weiterhin sollte darauf geachtet werden, daß das Stringgadget, die
  305. Fortschrittsanzeige und die Textfelder annähernd die gleiche Höhe
  306. haben, da es sonst zu unschönen Treppen kommen kann.
  307.  
  308. 7.) Distribution, Dankeschön und Autor
  309.  
  310. ATB ist Freeware, es darf kein Profit einzig und allein mit dieser
  311. Software gemacht werden. Das Copyright bleibt bei den Autoren.
  312. Jede kommerzielle Distribution ist grundsätzlich erlaubt, wenn die
  313. Autoren ein Exemplar des zu Distributierenden Objektes kostenlos erhalten.
  314.  
  315. "Dankeschön" an alle die mir fleissig EMail geschickt haben mit vielen
  316. Verbesserungsvorschlägen und Fehlerberichten. Ich hoffe ich kann alle
  317. mit dieser Version fürs erste eine Zeit lang bei Laune halten :-)
  318.  
  319. Besonderen Dank an "Phanlord" alias Aris Basic, der mir einen voll funktions-
  320. fähigen Preferences Editor geschrieben hat! Leider mußte ich das Preferences
  321. Format geringfügig ändern, so daß man den tollen Editor jetzt nicht mehr
  322. benutzen kann. ;-( Aber wer weiss..
  323.  
  324. Autor:
  325.  
  326. Daniel Balster, student of computer science and math @uni-paderborn.de
  327.  
  328. ----------------------------------------------------------------------
  329. some stuff for you to discover:
  330.  
  331. -- all used templates for commando line parsing:, some are useless actually
  332.  
  333.     from classes/ButtonPanel.c
  334.  
  335.     options of the 2. line    "REGISTERTITLES/M/A"
  336.     "button intro" options    "NUM=BUTTONS/K/N/A,ROWS/K/N,COLS/K/N,HELP"
  337.     "button" options        "TITLE/A,IMG=IMAGE/K,KEY=SHORTCUT/A,CMD=COMMAND/A,PATH/A,STACK/N/A,PRI=PRIORITY/N/A,Q=QUIET/S,WBSTART/S,REMAP/S,TRANS/S,HELP"
  338.  
  339.     options of the program:    "CFG=CONFIG/K,Q=QUIET/S"
  340.     options of the 1. line    "T=TOP/N/K,L=LEFT/N/K,W=WIDTH/N/K,MD=MEMORYDISPLAY/S,TD=TITLEDISPLAY/S,CP=COMMANDPANEL/S,MDW=MDWeight/N,TDW=TDWeight/N,CPW=CPWeight/N,CHIP/S,FAST/S,VMEM/S,HISTORY/K"
  341.     
  342. -- default values from classes/CommandLauncher.c
  343.  
  344.         data->command    = data->args = data->path = 0;
  345.         data->stack    = 4096;
  346.         data->prio    = 0;
  347.         data->quiet    = 0;
  348.  
  349. -- default values from classes/CommandPanel.c
  350.  
  351.         commandline = NewObject(CL_CommandLauncher->mcc_Class,NULL,
  352.             MUIA_CommandLauncher_Stack    , 8192,
  353.             MUIA_CommandLauncher_Priority    , 0,
  354.             MUIA_CommandLauncher_Path    , "RAM:",
  355.             TAG_DONE));
  356.  
  357. -- Because remapping was too slow I've hacked this quick and dirty "Icon-Grabber"
  358.    into it. It works fine with NewIcons installed.
  359.  
  360.     if (data->dobj = GetDiskObjectNew(data->name))
  361.     {
  362.         if (data->bmp = AllocBitMap(data->dobj->do_Gadget.Width,data->dobj->do_Gadget.Height,8,BMF_CLEAR,0))
  363.         {
  364.             struct RastPort TMPRP;
  365.             InitRastPort(&TMPRP);
  366.             TMPRP.BitMap = data->bmp;
  367.             DrawImage(&TMPRP,data->dobj->do_Gadget.GadgetRender,1,1);
  368.  
  369.             ...
  370. -- versions:
  371.  
  372.     atb.000        for plain 68000 lovers (no optimizations)
  373.     
  374.     atb.020        heavy 020 and above optimized (no math -> no fpu)
  375.     
  376.     atb.020+VMM    atb with VMM polling (affects memory display)
  377.